|
ata6505 2.2.1
|
API for configuring and manipulating ATA6505 Click driver. More...
Topics | |
| ATA6505 Device Settings | |
| Settings for registers of ATA6505 Click driver. | |
| ATA6505 MikroBUS Map | |
| MikroBUS pin mapping of ATA6505 Click driver. | |
Functions | |
| void | ata6505_cfg_setup (ata6505_cfg_t *cfg) |
| ATA6505 configuration object setup function. | |
| err_t | ata6505_init (ata6505_t *ctx, ata6505_cfg_t *cfg) |
| ATA6505 initialization function. | |
| err_t | ata6505_generic_write (ata6505_t *ctx, uint8_t *data_in, uint16_t len) |
| ATA6505 data writing function. | |
| err_t | ata6505_generic_read (ata6505_t *ctx, uint8_t *data_out, uint16_t len) |
| ATA6505 data reading function. | |
| void | ata6505_set_en_pin (ata6505_t *ctx, uint8_t state) |
| ATA6505 set EN pin function. | |
| uint8_t | ata6505_get_nres_pin (ata6505_t *ctx) |
| ATA6505 get NRES pin function. | |
API for configuring and manipulating ATA6505 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void ata6505_cfg_setup | ( | ata6505_cfg_t * | cfg | ) |
ATA6505 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See ata6505_cfg_t object definition for detailed explanation. |
| err_t ata6505_generic_read | ( | ata6505_t * | ctx, |
| uint8_t * | data_out, | ||
| uint16_t | len ) |
ATA6505 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See ata6505_t object definition for detailed explanation. |
| [out] | data_out | : Output read data. |
| [in] | len | : Number of bytes to be read. |
>0 - Number of data bytes read, <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation. | err_t ata6505_generic_write | ( | ata6505_t * | ctx, |
| uint8_t * | data_in, | ||
| uint16_t | len ) |
ATA6505 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See ata6505_t object definition for detailed explanation. |
| [in] | data_in | : Data buffer for sending. |
| [in] | len | : Number of bytes for sending. |
>=0 - Success, <0 - Error. See #err_t definition for detailed explanation. | uint8_t ata6505_get_nres_pin | ( | ata6505_t * | ctx | ) |
ATA6505 get NRES pin function.
This function returns the NRES pin logic state.
| [in] | ctx | : Click context object. See ata6505_t object definition for detailed explanation. |
| err_t ata6505_init | ( | ata6505_t * | ctx, |
| ata6505_cfg_t * | cfg ) |
ATA6505 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See ata6505_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See ata6505_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation.